Skip to main content

All Questions

5votes
2answers
411views

Testable documentation

I'm creating a library, and I would like to provide a tutorial on how to use the library. Such a tutorial will contain code snippets as usage examples; therefore, I would like to test these snippets ...
Josef Kufner's user avatar
4votes
2answers
3kviews

How to approach the understanding, documentation and validation of legacy code [duplicate]

I've been tasked with studying a Python code, which runs on an orchestrator, which schedule the launch of the code in correspondence of some events. The code imports some modules, and it's basically ...
DeltaIV's user avatar
1vote
1answer
100views

Should usage examples in XML documentation be explicitly tested?

If usage examples are provided in XML documentation, should those examples be explicitly tested? /// <summary> /// Gets a collection of Foo objects. /// </summary> /// <param name="...
Michael J.'s user avatar
0votes
2answers
248views

Documenting reports for end-users

I have an application that has about a dozen reports that provide totals and summaries of data in the database based on date ranges given as parameters. The application is near the end of user testing....
Paul Anderson's user avatar
8votes
5answers
4kviews

Is a functional spec a part of the System requirement spec?

I wonder, sources like wikipedia or templates I found shows that Functional spec is a part of System requirement documents. I always thought that SRD is just overall decsription of the system, with ...
John V's user avatar
  • 4,946
3votes
4answers
843views

What Does It Usually Mean for a Feature to be "Supported"?

I'm currently working some testing for a particular area of an application. I had to write some automated tests for a particular feature but due to the circumstances, this was not easy to do. When I ...
joshin4colours's user avatar
7votes
4answers
5kviews

Is functional spec a "design document"?

So I have been a bit lost in the terms, so first of all I present you what I have learned so far: System requirements specification - what users want, what the system should do Functional requirement -...
John V's user avatar
  • 4,946
3votes
3answers
2kviews

Ways to present testing results

I'm doing a school project which requires us to create a computer application and then write documentation; therefore I have to write testing documentation, I already have a of test plan (Validate all ...
Samantha Catania's user avatar
7votes
4answers
14kviews

Software testing automation documentation

What document types could be used when describing software testing automation (on any phase, automation planning, test design, implementation, reporting)? Is there any standard types of documents? If ...
user1007754's user avatar
1vote
1answer
2kviews

Usefulness of Javadocs with unit testing?

I am sure some else has experienced the problem of documentation regarding unit tests. I was wondering if anyone has used javadocs with their unit testing to generate their own internal javadoc files ...
grebwerd's user avatar
16votes
4answers
17kviews

Writing Acceptance test cases

We are integrating a testing process in our SCRUM process. My new role is to write acceptance tests of our web applications in order to automate them later. I have read a lot about how tests cases ...
H-H's user avatar
  • 671
8votes
2answers
6kviews

Can you recommend a good test plan template?

Can you recommend a good test plan template for an agile testing team? I know there are templates for testing on the web and have already looked at some found by search engines, but I could really ...
Ethel Evans's user avatar

close